ファイルの準備

概要

スクリプト方式のエクステンションを開発する場合、開発フォルダを任意の場所に作成して次のファイルを用意します。

  • 必要なファイル
    • マニフェストファイル (manifest.json) ･･･ エクステンションの定義
    • スクリプトファイル ･･･ エントリーポイントとなる C# スクリプトファイル
    • ロケールファイル (locale.*.json) ･･･ ローカライズ言語ごとの定義（多言語対応の場合のみ必要）

例えば、スクリプト方式で helloworld という名前のエクステンションを開発する場合、次のようなファイル構成が基本になります。

helloworld/
    manifest.json
    main.cs
    locale.en.json (多言語対応の場合)
    locale.ja.json (多言語対応の場合)
    resources/
        button.png

マニフェストファイル

  • Next Design のエクステンションには、manifest.json という名前のファイルが必ず1つ必要です。これを マニフェスト と呼びます。
  • このマニフェストには、次の定義を記述します。
    • エクステンションの概要
    • エントリーポイントとなるファイル名
    • ライフサイクル
    • UIやイベント、コマンドの拡張ポイント
  • マニフェストファイルの文字コードには UTF-8 を使用します。
  • マニフェストで指定するリボン上のアイコン画像は PNG 形式のファイルとして用意します。

manifest.json

{
    "name": "HelloWorld",
    "main": "main.cs",
    "lifecycle": "application",

    "extensionPoints": {
        ...
    }
}

リファレンス

スクリプトファイル

  • マニフェストに定義した拡張ポイントから呼び出されるハンドラをスクリプトファイルに実装します。
  • 拡張ポイントから呼び出されるハンドラが実装されているファイルを エントリーポイント と呼びます。
  • マニフェストに指定できるエントリーポイントは１つだけです。すべてのハンドラは１つのエントリーポイントに実装する必要があります。

詳細

ロケールファイル(任意)

  • エクステンションを多言語対応する場合は、ローカライズ言語ごとに locale.{lang}.json という名前のロケールファイルを定義します。

詳細